docutils - added missing stubs for __init__ methods #5924
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
srittau
requested changes
Aug 14, 2021
There was a problem hiding this comment.
Thanks, stubtest has a few complaints. Some more notes below.
Also, could you update the version in METADATA.toml to 0.17?
|
Thanks for the incredibly quick comments @srittau I'll address them now. |
|
@srittau I think that's the lot! Thank you so much for your fast and detailed feedback! |
srittau
requested changes
Aug 14, 2021
…annot express them currently
Akuli
reviewed
Aug 14, 2021
Co-authored-by: Akuli <[email protected]>
Akuli
approved these changes
Aug 14, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
OptionParserandDirectiveclasses had no__init__method stubs which was causing mypy to claim my valid arguments were not expected.For the
Directiveclass I used the documentation from https://docutils.sourceforge.io/0.4/docs/howto/rst-directives.html as my guide.For the
OptionParserclass I referred to the original source code: and some implementation examples from Sphinx.It's worth calling out the
componentsparameter as it expects a class rather than an object to be passed in (see the Sphinx example for confirmation).I have read the contribution guidelines and I think everything here is up to code, if not I'll fix it ASAP!